Создание нового пользователя

Запрос позволяет создать запись о новом пользователе клиента.

Синтаксис запроса

POST https://business.taxi.yandex.ru/api/1.0/client/{идентификатор клиента}/user/

🔴 Рекомендуем использовать API 2.0. Поддержка API 1.0 в будущем будет прекращена.

Заголовки запроса:

Authorization

OAuth-токен. Процесс получения токена описан в разделе Начало работы.

Данные о новом пользователе передаются в теле запроса в формате JSON:

Поле	Описание	Формат
`email`	Адрес электронной почты пользователя. Обязательное поле. Может быть пустой строкой.	Строка
`fullname`	Полное имя пользователя. Обязательное поле. Может быть пустой строкой.	Строка
`nickname`	Краткое имя пользователя. Необязательное поле.	Строка
`phone`	Телефонный номер пользователя. Обязательное поле.	Строка
`is_active`	Признак активности пользователя. Обязательное поле. Неактивный пользователь не имеет возможности самостоятельного заказа и на его имя нельзя заказать поездку.	Логическое
`department_id`	Идентификационный номер подразделения. Необязательное поле.	Строка
`role`	Блок с информацией о роли пользователя. Обязательное поле. Роль можно указать следующими способами: - При помощи идентификатора уже существующей роли. - При помощи описания новой роли пользователя. Поля с описанием роли аналогичны полям запроса Создание новой роли (кроме поля name).	Объект
`role_id`	Идентификационный номер роли пользователя.	Строка
`classes`	Список доступных пользователю тарифов. Данное поле следует передавать, если не был передан параметр `role_id` в блоке `role`.	Массив
`limit`	Ограничения на сумму, которую пользователь может потратить на поездки за календарный месяц. Необязательное поле.	Строка
`cost_center`	Название кост-центра клиента по умолчанию. Необязательное поле.	Строка
`cost_centers`	Информация о доступных кост-центрах. Необязательное поле. Является устаревшим: при наличии новых центров затрат включать его не нужно. Содержит следующие поля: `"required": bool, "format": "string", "values": ["cost_center_1", "cost_center_2"]` `required` — признак того, что указание кост-центра обязательно. `format` — формат указания центра затрат для сотрудника. Возможные значения: `select` — сотрудник выбирает кост-центр из списка. `text` — сотрудник самостоятельно указывает кост-центр в текстовом поле. `mixed` — сотруднику доступны выбор кост-центра из списка и свободный ввод в текстовом поле. `values` — список кост-центров, доступных для сотрудника. Формат списка `"кост_центр1","кост_центр2", ...`. Доступен только при значении формата `mixed` и `select`.	Объект
`cost_centers_id`	id набора настроек центров затрат (при наличии у клиента новых центров затрат). Необязательное поле. Если не включать поле в запрос, пользователю будет назначен основной центр затрат (при наличии у клиента новых центров затрат).	Строка

Описание полей ответа

В ответе могут содержаться следующие поля:

Поле	Описание	Формат
`_id`	Идентификационный номер пользователя.	Строка

Примеры запросов

Запрос с указанием существующей роли:

POST https://business.taxi.yandex.ru/api/1.0/client/a2d...d09/user/
...
Authorization: <OAuth-токен>

    {
        "email": "example-mail@example-company.ru",
        "fullname": "Иванов Илья",
        "nickname": "ИИлья",
        "department_id": "233e725b0511459da7b38cb24f2d8fd7",
        "role": {
            "role_id": "620d2b39bb154e3ebe5debc8341b3471"
        },
        "phone": "+75551234567",
        "is_active": false,
        "cost_center": "some cost center",
        "cost_centers_id": "123...fef",
        "cost_centers": {
            "required": true,
            "format": "mixed",
            "values": ["центр затрат 1", "центр затрат 2"]
        }
    }

Запрос с указанием новой роли:

POST https://business.taxi.yandex.ru/api/1.0/client/a2...d09/user/
...
Authorization: <OAuth-токен>

    {
        "email": "example-mail@example-company.ru",
        "fullname": "Иванов Илья",
        "nickname": "ИИлья",
        "department_id": "620d2b39bb154e3ebe5debc8341b3471",
        "role": {
            "limit": 10000,
            "classes": ["econom"],
            "restrictions": [
                {
                    "days": ["mo", "we", "sa"],
                    "start_time": "00:00:00",
                    "end_time": "23:59:00",
                    "type": "weekly_date"
                }
            ],
            "geo_restrictions": [
                {
                    "source": "geo_restriction_id1", 
                    "destination": "geo_restriction_id2";
                },
                {
                    "source": "geo_restriction_id3";
                }
            ]
        },
        "phone": "+75551234567",
        "is_active": false,
        "cost_center": "some cost center",
        "cost_centers": {
            "required": true,
            "format": "mixed",
            "values": ["центр затрат 1", "центр затрат 2"]
        }
    }

Пример ответа

Пример ответа на данный запрос выглядит следующим образом:

{
        "_id": "3caa3587675b49deb62e3286b753b05e"
}

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

200 — запрос выполнен успешно.
400 — в запросе был передан неизвестный параметр или параметр с недопустимым значением.
401 — был передан неверный OAuth-токен.
403 — у клиента не хватает прав на выполнение данного запроса.
406 — запись с указанными параметрами уже существует.

Была ли статья полезна?

Список пользователей клиента

Детальная информация о пользователе